KFbxIOSettings Class Reference

#include <kfbxiosettings.h>

Inheritance diagram for KFbxIOSettings:

[legend]

List of all members.

---

Detailed Description

KFbxIOSettings Class used as container for IO settings.

All settings are organized in a property hierarchy. A node of settings may contain a bunch of information related to an operation (ex: import / export). It may also contain informations related to a user dialog offering user options.

Definition at line 165 of file kfbxiosettings.h.

Public Member Functions
virtual void	Destruct (bool pRecursive, bool pDependents)
KFbxProperty	AddPropertyGroup (char const *pName, KFbxDataType const &pDataType=KFbxDataType(), char const *pLabel="")
	Add a property group under the root prop.
KFbxProperty	AddPropertyGroup (KFbxProperty const &pParentProperty, char const *pName, KFbxDataType const &pDataType=KFbxDataType(), char const *pLabel="", bool pVisible=true, bool pSavable=true, bool pEnabled=true)
	Add a property group under another parent prop.
KFbxProperty	AddProperty (KFbxProperty const &pParentProperty, char const *pName, KFbxDataType const &pDataType=KFbxDataType(), char const *pLabel="", void const *pValue=NULL, EFbxType pValueType=eUNIDENTIFIED, bool pVisible=true, bool pSavable=true, bool pEnabled=true)
	Add a property under another parent prop with a value to set.
KFbxProperty	AddPropertyMinMax (KFbxProperty const &pParentProperty, char const *pName, KFbxDataType const &pDataType=KFbxDataType(), char const *pLabel="", void const *pValue=NULL, double const *pMinValue=NULL, double const *pMaxValue=NULL, EFbxType pValueType=eUNIDENTIFIED, bool pVisible=true, bool pSavable=true, bool pEnabled=true)
	Add a property under another parent prop with a value to set and a min max values.
KFbxProperty	GetProperty (char const *pName) const
	get a prop by description ex: "Export|Animation|Bake"
KFbxProperty	GetProperty (KFbxProperty const &pParentProperty, char const *pName) const
	get prop by description from a parent property
bool	GetBoolProp (char const *pName, bool pDefValue) const
	get a bool prop by prop path
void	SetBoolProp (char const *pName, bool pValue)
	set a bool prop by prop path
double	GetDoubleProp (char const *pName, double pDefValue) const
	get a double prop by prop path
void	SetDoubleProp (char const *pName, double pValue)
	set a double prop by prop path
int	GetIntProp (char const *pName, int pDefValue) const
	get a int prop by prop path
void	SetIntProp (char const *pName, int pValue)
	set a int prop by prop path
KTime	GetKTimeProp (char const *pName, KTime pDefValue) const
	get a KTime prop by prop path
void	SetKTimeProp (char const *pName, KTime pValue)
	set a KTime prop by prop path
KString	GetEnumProp (char const *pName, KString pDefValue) const
	get an enum prop by prop path
int	GetEnumProp (char const *pName, int pDefValue) const
	get an enum prop by prop path
int	GetEnumIndex (char const *pName, KString pValue) const
	get an enum prop by prop path
void	SetEnumProp (char const *pName, KString pValue)
	set an enum prop by prop path
void	SetEnumProp (char const *pName, int pValue)
	set an enum prop by prop path
void	RemoveEnumPropValue (char const *pName, KString pValue)
	remove an enum prop by enum value
void	EmptyEnumProp (char const *pName)
	empty all the values of the enum prop
bool	IsEnumExist (KFbxProperty &pProp, KString &enumString) const
	check enum value if present
int	GetEnumIndex (KFbxProperty &pProp, KString &enumString, bool pNoCase=false) const
	get enum index
bool	SetFlag (char const *pName, FbxPropertyFlags::eFbxPropertyFlags propFlag, bool pValue)
	set a specific flag value on a specific property.
KString	GetStringProp (char const *pName, KString pDefValue) const
	get a string prop by prop path
void	SetStringProp (char const *pName, KString pValue)
	set a string prop by prop path
virtual bool	ReadXMLFile (KString &path)
	Load the settings hierarchy from an XML file.
virtual bool	WriteXMLFile (KString &path)
	Write the settings hierarchy to an XML file.
bool	WriteXmlPropToFile (KString &pFullPath, KString &propPath)
	Write the settings hierarchy to an XML file.

---

Member Function Documentation

virtual void Destruct	(	bool	pRecursive,
		bool	pDependents
	)			[virtual]

KFbxProperty AddPropertyGroup	(	char const *	pName,
		KFbxDataType const &	pDataType = KFbxDataType(),
		char const *	pLabel = ""
	)

Add a property group under the root prop.

Parameters:

	pName
	pDataType
	pLabel

KFbxProperty AddPropertyGroup	(	KFbxProperty const &	pParentProperty,
		char const *	pName,
		KFbxDataType const &	pDataType = KFbxDataType(),
		char const *	pLabel = "",
		bool	pVisible = true,
		bool	pSavable = true,
		bool	pEnabled = true
	)

Add a property group under another parent prop.

Parameters:

	pParentProperty
	pName
	pDataType
	pLabel
	pVisible
	pSavable
	pEnabled

KFbxProperty AddProperty	(	KFbxProperty const &	pParentProperty,
		char const *	pName,
		KFbxDataType const &	pDataType = KFbxDataType(),
		char const *	pLabel = "",
		void const *	pValue = NULL,
		EFbxType	pValueType = eUNIDENTIFIED,
		bool	pVisible = true,
		bool	pSavable = true,
		bool	pEnabled = true
	)

Add a property under another parent prop with a value to set.

Parameters:

	pParentProperty
	pName
	pDataType
	pLabel
	pValue
	pValueType
	pVisible
	pSavable
	pEnabled

KFbxProperty AddPropertyMinMax	(	KFbxProperty const &	pParentProperty,
		char const *	pName,
		KFbxDataType const &	pDataType = KFbxDataType(),
		char const *	pLabel = "",
		void const *	pValue = NULL,
		double const *	pMinValue = NULL,
		double const *	pMaxValue = NULL,
		EFbxType	pValueType = eUNIDENTIFIED,
		bool	pVisible = true,
		bool	pSavable = true,
		bool	pEnabled = true
	)

Add a property under another parent prop with a value to set and a min max values.

Parameters:

	pParentProperty
	pName
	pDataType
	pLabel
	pValue
	pMinValue
	pMaxValue
	pValueType
	pVisible
	pSavable
	pEnabled

KFbxProperty GetProperty

(

char const *

pName

)

const

get a prop by description ex: "Export|Animation|Bake"

Parameters:

pName

KFbxProperty GetProperty	(	KFbxProperty const &	pParentProperty,
		char const *	pName
	)			const

get prop by description from a parent property

Parameters:

	pParentProperty
	pName

bool GetBoolProp	(	char const *	pName,
		bool	pDefValue
	)			const

get a bool prop by prop path

Parameters:

	pName
	pDefValue

void SetBoolProp	(	char const *	pName,
		bool	pValue
	)

set a bool prop by prop path

Parameters:

	pName
	pValue

double GetDoubleProp	(	char const *	pName,
		double	pDefValue
	)			const

get a double prop by prop path

Parameters:

	pName
	pDefValue

void SetDoubleProp	(	char const *	pName,
		double	pValue
	)

set a double prop by prop path

Parameters:

	pName
	pValue

int GetIntProp	(	char const *	pName,
		int	pDefValue
	)			const

get a int prop by prop path

Parameters:

	pName
	pDefValue

void SetIntProp	(	char const *	pName,
		int	pValue
	)

set a int prop by prop path

Parameters:

	pName
	pValue

KTime GetKTimeProp	(	char const *	pName,
		KTime	pDefValue
	)			const

get a KTime prop by prop path

Parameters:

	pName
	pDefValue

void SetKTimeProp	(	char const *	pName,
		KTime	pValue
	)

set a KTime prop by prop path

Parameters:

	pName
	pValue

KString GetEnumProp	(	char const *	pName,
		KString	pDefValue
	)			const

get an enum prop by prop path

Parameters:

	pName
	pDefValue

int GetEnumProp	(	char const *	pName,
		int	pDefValue
	)			const

get an enum prop by prop path

Parameters:

	pName
	pDefValue

int GetEnumIndex	(	char const *	pName,
		KString	pValue
	)			const

get an enum prop by prop path

Parameters:

	pName
	pValue

void SetEnumProp	(	char const *	pName,
		KString	pValue
	)

set an enum prop by prop path

Parameters:

	pName
	pValue

void SetEnumProp	(	char const *	pName,
		int	pValue
	)

set an enum prop by prop path

Parameters:

	pName
	pValue

void RemoveEnumPropValue	(	char const *	pName,
		KString	pValue
	)

remove an enum prop by enum value

Parameters:

	pName
	pValue

void EmptyEnumProp

(

char const *

pName

)

empty all the values of the enum prop

Parameters:

pName

bool IsEnumExist	(	KFbxProperty &	pProp,
		KString &	enumString
	)			const

check enum value if present

Parameters:

	&pProp	a ref to an enum prop
	&enumString	s ref to string

int GetEnumIndex	(	KFbxProperty &	pProp,
		KString &	enumString,
		bool	pNoCase = false
	)			const

get enum index

Parameters:

	&pProp	a ref to an enum prop
	&enumString	s ref to string
	pNoCase

bool SetFlag	(	char const *	pName,
		FbxPropertyFlags::eFbxPropertyFlags	propFlag,
		bool	pValue
	)

set a specific flag value on a specific property.

Parameters:

	pName
	propFlag
	pValue

KString GetStringProp	(	char const *	pName,
		KString	pDefValue
	)			const

get a string prop by prop path

Parameters:

	pName
	pDefValue

void SetStringProp	(	char const *	pName,
		KString	pValue
	)

set a string prop by prop path

Parameters:

	pName
	pValue

virtual bool ReadXMLFile

(

KString &

path

)

[virtual]

Load the settings hierarchy from an XML file.

Parameters:

path

The path of the XML file.

Returns:

True on success, false otherwise.

virtual bool WriteXMLFile

(

KString &

path

)

[virtual]

Write the settings hierarchy to an XML file.

Parameters:

path

The path of the XML file.

Returns:

True on success, false otherwise.

bool WriteXmlPropToFile	(	KString &	pFullPath,
		KString &	propPath
	)

Write the settings hierarchy to an XML file.

Parameters:

	pFullPath	The path of the XML file.
	propPath	a prop Path

Returns:

True on success, false otherwise.